home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / basic / basxrf.zip / BASICXR.DOC next >
Text File  |  1991-06-05  |  9KB  |  273 lines
  1.                    
  2.                    
  3.                    
  4.                      BasicXR Cross Reference Utility                       
  5.                          <c> 1991  JNGoodale
  6.  
  7.                              DOCUMENTATION
  8.  
  9.     Files included: BASICXR.EXE     Shareware version
  10.                     BASICXR.DOC     This file
  11.                     BASICXRW.XXT    Starter file for Custom Res Words
  12.                     ORDER.DOC       Order blank
  13.                     README.TXT      Brief documentation
  14.  
  15.                     BASICXRF.EXE    Distributed with registered version
  16.  
  17.     This document covers the following:
  18.  
  19.             1.  General description
  20.             2.  Start-up
  21.             3.  Printer control codes
  22.             4.  Printing to a file
  23.             5.  Forcing a page eject
  24.             6.  Creating a file of Reserved Words
  25.             7.  Requirements/Limitations
  26.             8.  Error messages
  27.             9.  Support
  28.            10.  Registration
  29.            11.  Shareware Concept
  30.  
  31.     ====================================================================
  32.   
  33.     1.  GENERAL DESCRIPTION
  34.  
  35.         This program will cross reference a program written in Basic
  36.         and saved as an ASCII file.  It will create any combination
  37.         of the following three options:
  38.  
  39.                     Formatted program listing
  40.                     User label/line number cross reference
  41.                     Reserved word cross reference
  42.  
  43.         BASICXR.EXE is the un-registered version and displays a
  44.         registration reminder each time it is run.
  45.  
  46.         BASICXRF.EXE is the registered version.  Both programs function
  47.         identically, but the registration reminder is removed from the
  48.         registered version, and it is about 5K shorter.  You receive
  49.         this version when you register.
  50.  
  51.  
  52.  
  53.                    
  54.                                Page 1 of 5
  55.  
  56.  
  57.  
  58.  
  59.     2.  START-UP
  60.  
  61.         To execute the program, simply enter BASICXR (or BASICXRF for
  62.         the registered version) followed optionally by "/ switches", as
  63.         described below:
  64.                 BASICXR/M  will force the program to assume monochrome
  65.                            display.  The program attempts to determine
  66.                            the type of monitor you have, but if you
  67.                            have a monochrome monitor and your prompt
  68.                            messages are not clear, try the "/M" switch.
  69.                 BASICXR/E  will send printer control codes for Epson
  70.                            compatible printers.  See # 3 below.
  71.                 BASICXR/D  will send printer control codes for DeskJet
  72.                            compatible printers.  See # 3 below.
  73.  
  74.         The "/M" switch can be used in conjunction with either of the
  75.         printer switches.  Order and case are not important.
  76.  
  77.  
  78.     3.  PRINTER CONTROL CODES                            
  79.  
  80.         If you elect to print compressed pitch for either an Epson or
  81.         DeskJet compatible printer, start the program with the
  82.         appropriate switch (/E or /D).  The program will send the
  83.         following printer control codes to your printer (or to the
  84.         output file, if you elect to output to a file for later printing):
  85.  
  86.                                 /D (DeskJet)            /E (Epson)
  87.  
  88.                 Reset           CHR$(27);"E"            CHR$(27);"@"
  89.                 Compressed      CHR$(27);"(s16.67H"     CHR$(15)
  90.  
  91.                 Line width      110 characters          120 characters
  92.                 Lines/page      54                      54
  93.  
  94.         In both cases the program resets the printer at the end.
  95.  
  96.         If you do not execute the program with one of the switches, no
  97.         control codes are sent.  Line width is 80, lines/page 54.
  98.  
  99.     4.  PRINTING TO A FILE
  100.  
  101.         By entering "f" or "F" at the prompt you can direct the output
  102.         to a file for later printing.  The name of the file created will
  103.         be the same base name as your input source file with an extension
  104.         of ".XRF".  It will be written to the same path as the source.
  105.                                 
  106.                                 
  107.                                 
  108.                                   Page  2 of 5
  109.  
  110.  
  111.  
  112.  
  113.     5.  FORCING A PAGE EJECT
  114.  
  115.         If you would like to force a page eject in the program listing,
  116.         simply insert a line with two single quotes as the only text on
  117.         the line - '' - NOT a double quote (").
  118.  
  119.         The single quote is shorthand for REM, so the two single quotes
  120.         will not affect your program, but will trigger a page eject in
  121.         BasicXR.
  122.  
  123.     6.  CREATING A FILE OF RESERVED WORDS                           
  124.  
  125.         BasicXR has a built in table of Microsoft QuickBasic 4.0 reserved
  126.         words.  For another dialect of Basic you can create your own set
  127.         in a file that must be called "BASICXRW.TXT".  This is simply a
  128.         text file of the reserved words.  A starter (BASICXRW.XXT) is
  129.         supplied with this program which you can use to edit to create
  130.         your own list.  It must be renamed to "BASICXRW.TXT" for it to
  131.         take effect.
  132.       
  133.         If your programs are written in Microsoft QuickBasic 4.0 you do
  134.         not need this file.
  135.       
  136.         Maximum size of BASICXRW.TXT is 400 entries.
  137.         Maximum record length for each entry is 16.
  138.  
  139.     7.  REQUIREMENTS/LIMITATIONS
  140.  
  141.         Minimum requirements to run BasicXR are:
  142.  
  143.                 IBM compatible computer
  144.                 Monochrome or color monitor
  145.                 Printer (unless printing to a file)
  146.                 DOS 2.11 or higher
  147.                 256K
  148.  
  149.         Programs to be cross-referenced must be saved in ASCII and have
  150.         the extension ".BAS".
  151.  
  152.         The program assumes Microsoft Basic dialects.  I do not guarantee
  153.         any other versions of Basic, although it might work.
  154.  
  155.         It will work with either line numbers (as in GWBasic) or line
  156.         labels (as in QuickBasic), but not both within the same program
  157.         (which QuickBasic allows for, but BasicXR doesn't).
  158.  
  159.         Customized Reserved Word file - Maximum 400 entries, Maximum
  160.         record length 16.
  161.  
  162.                                   Page  3 of 5
  163.  
  164.  
  165.  
  166.  
  167.         The size of the program it can handle is based on how much main
  168.         memory you have (up to 640K) and how many references there are.
  169.         If it runs out of room for the reference table, the program
  170.         notifies you, marks the listing where referencing will stop, and
  171.         continues the listing, if that option is turned on.
  172.  
  173.         The solution at this point would be to break the program into
  174.         several parts and then run each part thru BasicXR.
  175.  
  176.     8.  ERROR MESSAGES
  177.  
  178.         The following error messages may occur:
  179.  
  180.             Bad Path entered
  181.             No *.BAS files
  182.             No options entered.  Ending
  183.             This is not an ASCII (text) file.  Ending
  184.             Reached max of 400 Reserved Words .. ignoring excess
  185.             Label reference table exceeded
  186.  
  187.         Except where "Ending" is stated, you are given the option to
  188.         [ESC] to quit or [ENTER] to try again.
  189.  
  190.     9.  SUPPORT
  191.  
  192.         Registered owners will receive free support for three months
  193.         after registration by contacting me thru US mail, CompuServe or
  194.         phone at:
  195.  
  196.                 Jane N. Goodale
  197.                 6851 Roswell Rd, Unit I-15
  198.                 Atlanta  GA  30328
  199.  
  200.                 (404)-392-0781
  201.  
  202.                 CIS PPN 71116,302
  203.  
  204.         If you find a serious program bug, you will be sent a "fixed"
  205.         program free of charge.
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.                                   Page  4 of 5
  217.  
  218.  
  219.  
  220.  
  221.     10. REGISTRATION
  222.  
  223.         Registration is available for $15.  You can fill out and print
  224.         the registration form within the program BASICXR.EXE or from
  225.         the order blank "ORDER.DOC".
  226.  
  227.         If you distribute copies of this program, please distribute the
  228.         self extracting file "BASXRF.